ShellPath user defined functions Reference

Below is a complete list of the user defined functions available in AutoIt. Click on a user defined function name for a detailed description.

When using them you need to add a #include <WinAPIShPath.au3>.

 

User Defined Function Description
_WinAPI_CommandLineToArgv Parses a command-line string and returns an array of the command-line arguments
_WinAPI_IsNameInExpression Determines whether a string matches the specified pattern
_WinAPI_ParseURL Performs rudimentary parsing of a URL
_WinAPI_ParseUserName Extracts the domain and user account name from a fully qualified user name
_WinAPI_PathAddBackslash Adds a backslash to the end of a string to create the correct syntax for a path
_WinAPI_PathAddExtension Adds a file name extension to a path string
_WinAPI_PathAppend Appends one path to the end of another
_WinAPI_PathBuildRoot Creates a root path from a given drive number
_WinAPI_PathCanonicalize Removes elements of a file path according to special strings inserted into that path
_WinAPI_PathCommonPrefix Compares two paths to determine if they share a common prefix
_WinAPI_PathCompactPath Truncates a file path to fit within a given pixel width by replacing path components with ellipses
_WinAPI_PathCompactPathEx Truncates a path to fit within a certain number of characters by replacing path components with ellipses
_WinAPI_PathCreateFromUrl Converts a file URL to a Microsoft MS-DOS path
_WinAPI_PathFindExtension Searches a path for an extension
_WinAPI_PathFindFileName Searches a path for a file name
_WinAPI_PathFindNextComponent Parses a path and returns the portion of that path that follows the first backslash
_WinAPI_PathFindOnPath Searchs for a file in the default system paths
_WinAPI_PathGetArgs Finds the command-line arguments within a given path
_WinAPI_PathGetCharType Determines the type of character in relation to a path
_WinAPI_PathGetDriveNumber Searches a path for a drive letter within the range of 'A' to 'Z' and returns the corresponding drive number
_WinAPI_PathIsContentType Determines if a file's registered content type matches the specified content type
_WinAPI_PathIsExe Determines whether a file is an executable by examining the file extension
_WinAPI_PathIsFileSpec Searches a path for any path-delimiting characters
_WinAPI_PathIsLFNFileSpec Determines whether a file name is in long format
_WinAPI_PathIsRelative Searches a path and determines if it is relative
_WinAPI_PathIsRoot Parses a path to determine if it is a directory root
_WinAPI_PathIsSameRoot Compares two paths to determine if they have a common root component
_WinAPI_PathIsSystemFolder Determines if an existing folder contains the attributes that make it a system folder
_WinAPI_PathIsUNC Determines if the string is a valid Universal Naming Convention (UNC) for a server and share path
_WinAPI_PathIsUNCServer Determines if a string is a valid Universal Naming Convention (UNC) for a server path only
_WinAPI_PathIsUNCServerShare Determines if a string is a valid Universal Naming Convention (UNC) share path
_WinAPI_PathMakeSystemFolder Gives an existing folder the proper attributes to become a system folder
_WinAPI_PathMatchSpec Searches a string using a Microsoft MS-DOS wild card match type
_WinAPI_PathParseIconLocation Parses a file location string that contains a file location and icon index
_WinAPI_PathRelativePathTo Creates a relative path from one file or folder to another
_WinAPI_PathRemoveArgs Removes any arguments from a given path
_WinAPI_PathRemoveBackslash Removes the trailing backslash from a given path
_WinAPI_PathRemoveExtension Removes the file name extension from a path, if one is present
_WinAPI_PathRemoveFileSpec Removes the trailing file name and backslash from a path, if they are present
_WinAPI_PathRenameExtension Replaces the extension of a file name with a new extension
_WinAPI_PathSearchAndQualify Formats a path to the fully qualified path
_WinAPI_PathSkipRoot Parses a path, ignoring the drive letter or Universal Naming Convention (UNC) server/share path elements
_WinAPI_PathStripPath Removes the path portion of a fully qualified path and file
_WinAPI_PathStripToRoot Removes all parts of the path except for the root information
_WinAPI_PathUndecorate Removes the decoration from a path string
_WinAPI_PathUnExpandEnvStrings Replaces folder names in a fully-qualified path with their associated environment string
_WinAPI_PathUnmakeSystemFolder Removes the attributes from a folder that make it a system folder
_WinAPI_PathUnquoteSpaces Removes quotes from the beginning and end of a path
_WinAPI_PathYetAnotherMakeUniqueName Creates a unique filename based on an existing filename
_WinAPI_ShellGetImageList Retrieves the system image list for small or large icons
_WinAPI_UrlApplyScheme Determines a scheme for a specified URL string, and returns a string with an appropriate prefix
_WinAPI_UrlCanonicalize Converts a URL string into canonical form
_WinAPI_UrlCombine Combines the base an relative URLs in canonical form
_WinAPI_UrlCompare Makes a case-sensitive comparison of two URL strings
_WinAPI_UrlCreateFromPath Converts a Microsoft MS-DOS path to a canonicalized URL
_WinAPI_UrlFixup Attempts to correct a URL whose protocol identifier is incorrect
_WinAPI_UrlGetPart Retrieves a specified part from the URL
_WinAPI_UrlHash Hashes a URL string
_WinAPI_UrlIs Tests whether or not a URL is a specified type